gh-1309: Document how to selectively build RST pages #1562
Conversation
There was a problem hiding this comment.
IMO this does not need a whole section, I've never built specific pages, by the time I've written the command make html would have finished anyway. I don't see much need for this here, especially such a large section.
A better place would be above in the .. tip:: explaining you can pass SOURCES="" with desired paths.
|
Stan, be aware that a lot of these changes are being discussed at the sprints in-person. |
|
I assumed so, yet I am not there :-(, so all I can do is comment. |
|
Right, but some changes have already been informally approved elsewhere, so it's not particularly helpful to say things like "IMO this does not need a whole section." I get that you're aspiring to be a triager or on the documentation team or whatever, but this isn't the way to go about it! Documentation reviews are the most helpful when they're about actually fixing typos or incorrect information, but wording and formality nitpicks (like you tend to suggest) are just noise that actually slow down documentation PRs. I think you would really benefit from having a core dev mentor that walked you through this. Have you asked around at all? |
Unfortunately I have no way of knowing this if it is not listed in the description.
It seems like quite an important thing in a documentation pr.
You must have missed quite a few of my reviews then.
Yes, several months ago. |
There was a problem hiding this comment.
Thanks @MichaByte for your contribution during the sprint. Also congrats on your first contribution to the devguide. 🎉 ☀️ I hope that there will be more in the future. 😄
This PR adds a small section to
documentation/start-documentingthat informs the reader of how to build only certain documentation pages. I tested my instructions on Linux and Windows. Please let me know if any changes are needed!Thanks,
Micha
📚 Documentation preview 📚: https://cpython-devguide--1562.org.readthedocs.build/